GET api/Properties?ids[0]={ids[0]}&ids[1]={ids[1]}&PropertyStatus={PropertyStatus}&page={page}&pageSize={pageSize}

Get properties from a specific market with a provided list of property IDs, if no property id is provided then we will return all properties linked to the user

Request Information

Authentication

This method requires user authentication

URI Parameters

Name	Description	Type	Additional information
ids	(Required)	Collection of integer	None.
PropertyStatus	(Optional) The records returned bases on isactive	string	Active
page	(Optional)The page number of returned records based on the page size	integer	0
pageSize	(Optional)The number of records to return per page	integer	0

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfProperty

Name	Description	Type	Additional information
Total		integer	None.
Elements		Collection of Property	None.

Response Formats

application/json, text/json

Sample:

{
  "Total": 1,
  "Elements": [
    {
      "PropertyId": 1,
      "C4Uid": "sample string 2",
      "PropertyName": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "Zip": "sample string 8",
      "EntityNumber": "sample string 9",
      "AccountingServerId": 1,
      "LegalName": "sample string 10",
      "PropertyTypeId": 1,
      "SecondaryPropertyTypeId": 1,
      "AccountingSoftwareId": 1,
      "PropertyStatus": true
    },
    {
      "PropertyId": 1,
      "C4Uid": "sample string 2",
      "PropertyName": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "Zip": "sample string 8",
      "EntityNumber": "sample string 9",
      "AccountingServerId": 1,
      "LegalName": "sample string 10",
      "PropertyTypeId": 1,
      "SecondaryPropertyTypeId": 1,
      "AccountingSoftwareId": 1,
      "PropertyStatus": true
    }
  ]
}

Internal Error Codes

106: ResourceNotFound
(The requested resource was not found., NotFound)
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest)
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest)
199: UnknownError
(Internal server error., InternalServerError)
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)